<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Chameleon-Mini: LiveLogTick.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Chameleon-Mini
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_74b6a3b63f61c160c0f14b7a283a4c9b.html">Firmware</a></li><li class="navelem"><a class="el" href="dir_8465ec698d237f801ae9966d4551fcfa.html">Chameleon-Mini</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">LiveLogTick.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/* LiveLogTick.h : Handle flushing of live logging buffers out through USB</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> *                 by an atomic code block with interrupts disabled.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> *                 If there are many logs being generated at once, this will maintain</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> *                 consistency in the returned buffers and prevent the contents of</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> *                 USB serial data from getting jumbled or concatenated.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;</div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#ifndef __LIVE_LOG_TICK_H__</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#define __LIVE_LOG_TICK_H__</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &lt;inttypes.h&gt;</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &lt;stdlib.h&gt;</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="preprocessor">#include &lt;avr/interrupt.h&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="preprocessor">#include &lt;avr/io.h&gt;</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="preprocessor">#include &lt;util/atomic.h&gt;</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;</div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_l_u_f_a_descriptors_8h.html">LUFADescriptors.h</a>&quot;</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_log_8h.html">Log.h</a>&quot;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &quot;Terminal/Terminal.h&quot;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="preprocessor">#define cli_memory() __asm volatile( &quot;cli&quot; ::: &quot;memory&quot; )</span></div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="preprocessor">#define sei_memory() __asm volatile( &quot;sei&quot; ::: &quot;memory&quot; )</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="preprocessor">#ifndef FLUSH_LOGS_ON_SPACE_ERROR</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="preprocessor">#define FLUSH_LOGS_ON_SPACE_ERROR       (1)</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span>LogBlockListNode {</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    uint8_t                  *logBlockDataStart;</div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    uint8_t                  logBlockDataSize;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <span class="keyword">struct </span>LogBlockListNode  *nextBlock;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;} LogBlockListNode;</div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#define LOG_BLOCK_LIST_NODE_SIZE             (sizeof(LogBlockListNode) + 4 - (uint8_t) (sizeof(LogBlockListNode) % 4))</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="keyword">extern</span> LogBlockListNode *LogBlockListBegin;</div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="keyword">extern</span> LogBlockListNode *LogBlockListEnd;</div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="keyword">extern</span> uint8_t LogBlockListElementCount;</div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#define LIVE_LOGGER_POST_TICKS               (6)</span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="keyword">extern</span> uint8_t LiveLogModePostTickCount;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;</div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;INLINE <span class="keywordtype">bool</span> AtomicAppendLogBlock(<a class="code" href="_log_8h.html#a34112fbd78128ae58dc7801690dfa6e0">LogEntryEnum</a> logCode, uint16_t sysTickTime, <span class="keyword">const</span> uint8_t *logData, uint8_t logDataSize);</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;INLINE <span class="keywordtype">void</span> FreeLogBlocks(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;INLINE <span class="keywordtype">bool</span> AtomicLiveLogTick(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;INLINE <span class="keywordtype">bool</span> LiveLogTick(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;INLINE <span class="keywordtype">bool</span></div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;AtomicAppendLogBlock(<a class="code" href="_log_8h.html#a34112fbd78128ae58dc7801690dfa6e0">LogEntryEnum</a> logCode, uint16_t sysTickTime, <span class="keyword">const</span> uint8_t *logData, uint8_t logDataSize) {</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keywordtype">bool</span> status = <span class="keyword">true</span>;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;    <span class="keywordflow">if</span> ((logDataSize + 4 + 3 + LOG_BLOCK_LIST_NODE_SIZE &gt; LogMemLeft) &amp;&amp; (LogMemPtr != LogMem)) {</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;        <span class="keywordflow">if</span> (FLUSH_LOGS_ON_SPACE_ERROR) {</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;            LiveLogTick();</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;            FreeLogBlocks();</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;        }</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;        status = <span class="keyword">false</span>;</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;    } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (logDataSize + 4 + 3 + LOG_BLOCK_LIST_NODE_SIZE &lt;= LogMemLeft) {</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;        uint8_t alignOffset = 4 - (uint8_t)(((uint16_t) LogMemPtr) % 4);</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;        uint8_t *logBlockStart = LogMemPtr + alignOffset;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;        LogBlockListNode logBlock;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;        LogMemPtr += LOG_BLOCK_LIST_NODE_SIZE + alignOffset;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;        LogMemLeft -= LOG_BLOCK_LIST_NODE_SIZE + alignOffset;</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;        logBlock.logBlockDataStart = LogMemPtr;</div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;        logBlock.logBlockDataSize = logDataSize + 4;</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;        logBlock.nextBlock = 0;</div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;        *(LogMemPtr++) = (uint8_t) logCode;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;        *(LogMemPtr++) = logDataSize;</div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;        *(LogMemPtr++) = (uint8_t)(sysTickTime &gt;&gt; 8);</div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;        *(LogMemPtr++) = (uint8_t)(sysTickTime &gt;&gt; 0);</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;        memcpy(LogMemPtr, logData, logDataSize);</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;        LogMemPtr += logDataSize;</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;        LogMemLeft -= logDataSize + 4;</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;        memcpy(logBlockStart, &amp;logBlock, <span class="keyword">sizeof</span>(LogBlockListNode));</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;        <span class="keywordflow">if</span> (LogBlockListBegin != NULL &amp;&amp; LogBlockListEnd != NULL) {</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;            LogBlockListEnd-&gt;nextBlock = (LogBlockListNode *) logBlockStart;</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;            LogBlockListEnd = (LogBlockListNode *) logBlockStart;</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;        } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;            LogBlockListBegin = LogBlockListEnd = (LogBlockListNode *) logBlockStart;</div><div class="line"><a name="l00078"></a><span class="lineno">   78</span>&#160;        }</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;        ++LogBlockListElementCount;</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;        status = <span class="keyword">false</span>;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;    }</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="keywordflow">return</span> status;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;}</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;INLINE <span class="keywordtype">void</span></div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;FreeLogBlocks(<span class="keywordtype">void</span>) {</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    LogMemPtr = &amp;LogMem[0];</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;    LogMemLeft = LOG_SIZE;</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;    LogBlockListBegin = LogBlockListEnd = NULL;</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;    LogBlockListElementCount = 0;</div><div class="line"><a name="l00092"></a><span class="lineno">   92</span>&#160;}</div><div class="line"><a name="l00093"></a><span class="lineno">   93</span>&#160;</div><div class="line"><a name="l00094"></a><span class="lineno">   94</span>&#160;INLINE <span class="keywordtype">bool</span></div><div class="line"><a name="l00095"></a><span class="lineno">   95</span>&#160;AtomicLiveLogTick(<span class="keywordtype">void</span>) {</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;    <span class="keywordflow">return</span> LiveLogTick();</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;}</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;</div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;INLINE <span class="keywordtype">bool</span></div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;LiveLogTick(<span class="keywordtype">void</span>) {</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;    LogBlockListNode logBlockCurrent, *tempBlockPtr = NULL;</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;    memcpy(&amp;logBlockCurrent, LogBlockListBegin, <span class="keyword">sizeof</span>(LogBlockListNode));</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;    <span class="keywordflow">while</span> (LogBlockListElementCount &gt; 0) {</div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;        TerminalFlushBuffer();</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;        TerminalSendBlock(logBlockCurrent.logBlockDataStart, logBlockCurrent.logBlockDataSize);</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;        TerminalFlushBuffer();</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;        tempBlockPtr = logBlockCurrent.nextBlock;</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;        <span class="keywordflow">if</span> (tempBlockPtr != NULL) {</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;            memcpy(&amp;logBlockCurrent, tempBlockPtr, <span class="keyword">sizeof</span>(LogBlockListNode));</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;        } <span class="keywordflow">else</span> {</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;            <span class="keywordflow">break</span>;</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;        }</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;        --LogBlockListElementCount;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;    }</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;    FreeLogBlocks();</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;    LiveLogModePostTickCount = 0;</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;    <span class="keywordflow">return</span> <span class="keyword">true</span>;</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;}</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="_log_8h_html_a34112fbd78128ae58dc7801690dfa6e0"><div class="ttname"><a href="_log_8h.html#a34112fbd78128ae58dc7801690dfa6e0">LogEntryEnum</a></div><div class="ttdeci">LogEntryEnum</div><div class="ttdef"><b>Definition:</b> Log.h:16</div></div>
<div class="ttc" id="_log_8h_html"><div class="ttname"><a href="_log_8h.html">Log.h</a></div></div>
<div class="ttc" id="_l_u_f_a_descriptors_8h_html"><div class="ttname"><a href="_l_u_f_a_descriptors_8h.html">LUFADescriptors.h</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Mar 17 2022 12:03:24 for Chameleon-Mini by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
